-
Notifications
You must be signed in to change notification settings - Fork 128
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve stratosphere documentation #3114
Conversation
Since ERA-Interim is in the main data pool
@valeriupredoi or @remi-kazeroni this is part 1 of fixes to close #1775. Would one of you be able to review please? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for tackling that @alistairsellar! I see that this documentation page somehow follows a different template with different titles for sections. For example model-data instead of variables (but that table looks nicer than the usual list of variables in other pages!) or input and usage instead of user settings in recipe (also nicer in this page, I think). Question: is it planned or possible to rename these sections following what is done for other recipes? But not necessarily reformat the entire sections which look nice here as they are. I leave the rest of the review to @valeriupredoi, don't really have more comments myself.
Co-authored-by: Rémi Kazeroni <remi.kazeroni@dlr.de>
Co-authored-by: Rémi Kazeroni <remi.kazeroni@dlr.de>
Thanks @remi-kazeroni! Good spot!. I've renamed the section titles, and also re-organise sections to follow what seems to be a more standard order. Also added ta and ua to the list of ERA-Interim vars. @valeriupredoi, Remi is leaving the final review to you... |
many thanks @alistairsellar - couple wiggles in the docs build:
Also - we may have to pin sphinx to latest as I have just done in Core - let's see if the tests pass with those two wiggles fixed first 🍺 |
Co-authored-by: Rémi Kazeroni <remi.kazeroni@dlr.de>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot @alistairsellar! Looks fine to me like this. The documentation page follows the same order as in other pages. All nice and clean 👍 @valeriupredoi you can take a final look and merge whenever you get time for this 🍺
on it now, gents.. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
spick and span, cheers @alistairsellar and Remi for reviewing 🍺
Brilliant - thanks guys! |
Description
This PR adds the required section "Available recipes and diagnostics" to the Autoassess stratosphere recipe.
Before you get started
Checklist
It is the responsibility of the author to make sure the pull request is ready to review. The icons indicate whether the item will be subject to the 🛠 Technical or 🧪 Scientific review.
New or updated recipe/diagnostic
To help with the number of pull requests: